Skip to main content
POST
Create a recipient
Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key
string
default:your-api-key
required

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

Path Parameters

client_id
string
required

Unique ID of the client for which you want to retrieve or update details. Refer to Getting the Client ID section for detailed instructions.

Body

application/json
recipient
object
required
email
string<email>
required

Email address of the creator.

Example:

"oliver@example.com"

Response

201 - application/json

Created - Recipient created successfully

notice_code
string