Skip to navigation
API ReferenceRecipients

Create a recipient

View as Markdown
Create a recipient.

Authentication

x-api-keystring

Account API key used to authenticate server-side requests. Use the credentials issued for the same environment as the API base URL.

Request

This endpoint expects an object.
namestringRequired<=120 characters
emailstringOptionalformat: "email"<=180 characters
Used to email them their invoices. No two recipients can share one.
phonestringOptional<=32 characters
No two recipients can share one.
referencestringOptional<=64 characters
Your own tag for whose list they are on. Email and phone are unique within a reference.

Response

Recipient created successfully.
messagestring
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error