Provisioning API

Update a sender

PATCH

/senders/{sender_id}

const url = 'https://live-api.customers.ac/v1/senders/snd_a1b2c3d4-e5f6-7890-abcd-ef1234567890';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"Acme Outbound Q2"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://live-api.customers.ac/v1/senders/snd_a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "Acme Outbound Q2" }'

Updates mutable fields on a sender (name, personas). You cannot change the user or status directly.

Authorizations

BearerAuth
senders:write

Parameters

Path Parameters

sender_id

required

string format: uuid

Example

snd_a1b2c3d4-e5f6-7890-abcd-ef1234567890

The unique identifier of the sender.

Request Body^required

application/json

object

>= 1 properties

name

A human-readable name for this sender.

string

<= 255 characters

personas

Replace all personas. This does not affect already-provisioned mailboxes.

Array<object>

A persona template. One mailbox is created per persona per domain (e.g., 3 personas x 3 domains = 9 mailboxes).

object

first_name

required

First name used in the mailbox address.

string

last_name

required

Last name used in the mailbox address.

string

title

Job title, used for display name in the mailbox.

string | null

Example

{
  "name": "Acme Outbound Q2"
}

Responses

200

Sender updated.

application/json

object

data

required

object

required

Unique identifier for the sender.

string format: uuid

user_id

required

The user this sender belongs to.

string format: uuid

name

required

A human-readable name for this sender, chosen by the partner.

string

status

required

The current lifecycle status of a sender.

string

Allowed values: pending provisioning active deprovisioning deprovisioned

personas

Templates used to generate mailbox usernames on each domain.

Array<object>

A persona template. One mailbox is created per persona per domain (e.g., 3 personas x 3 domains = 9 mailboxes).

object

first_name

required

First name used in the mailbox address.

string

last_name

required

Last name used in the mailbox address.

string

title

Job title, used for display name in the mailbox.

string | null

domains_count

Number of domains connected to this sender.

integer

mailboxes_count

Total number of mailboxes across all domains.

integer

created_at

required

string format: date-time

updated_at

required

string format: date-time

Example

{
  "data": {
    "id": "snd_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "user_id": "usr_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Acme Outbound Q1",
    "status": "pending",
    "personas": [
      {
        "first_name": "Jane",
        "last_name": "Doe",
        "title": "Head of Partnerships"
      }
    ],
    "domains_count": 3,
    "mailboxes_count": 9,
    "created_at": "2026-03-20T09:00:00Z",
    "updated_at": "2026-03-20T12:30:00Z"
  }
}

400

The request body failed validation.

application/json

object

error

required

object

code

required

A machine-readable error code.

string

Allowed values: auth.missing_key auth.invalid_key auth.insufficient_scope rate.quota_exceeded validation.required_field validation.invalid_value resource.not_found resource.already_exists resource.not_ready server.error

message

required

A human-readable explanation of the error.

string

doc_url

A link to the documentation page for this error code.

string format: uri

details

For validation errors, a list of individual field-level problems.

Array<object> | null

object

field

required

The field that caused the error, in dot notation.

string

code

A machine-readable code for this specific validation issue.

string

message

required

A human-readable explanation.

string

Example

{
  "error": {
    "code": "validation.required_field",
    "message": "The request body is missing required fields.",
    "doc_url": "https://docs.sending.ac/errors/validation-required-field",
    "details": [
      {
        "field": "email",
        "code": "validation.required_field",
        "message": "This field is required."
      }
    ]
  }
}

401

Authentication failed. The API key is missing or invalid.

application/json

object

error

required

object

code

required

A machine-readable error code.

string

message

required

A human-readable explanation of the error.

string

doc_url

A link to the documentation page for this error code.

string format: uri

details

For validation errors, a list of individual field-level problems.

Array<object> | null

object

field

required

The field that caused the error, in dot notation.

string

code

A machine-readable code for this specific validation issue.

string

message

required

A human-readable explanation.

string

Examples

No API key provided

{
  "error": {
    "code": "auth.missing_key",
    "message": "No API key was provided. Include your key in the Authorization header: Bearer sac_live_xxxxx.",
    "doc_url": "https://docs.sending.ac/errors/auth-missing-key"
  }
}

Invalid API key

{
  "error": {
    "code": "auth.invalid_key",
    "message": "The API key provided is invalid or has been revoked.",
    "doc_url": "https://docs.sending.ac/errors/auth-invalid-key"
  }
}

403

The API key does not have the required scope for this operation.

application/json

object

error

required

object

code

required

A machine-readable error code.

string

message

required

A human-readable explanation of the error.

string

doc_url

A link to the documentation page for this error code.

string format: uri

details

For validation errors, a list of individual field-level problems.

Array<object> | null

object

field

required

The field that caused the error, in dot notation.

string

code

A machine-readable code for this specific validation issue.

string

message

required

A human-readable explanation.

string

Example

{
  "error": {
    "code": "auth.insufficient_scope",
    "message": "Your API key does not have the 'senders:write' scope required for this operation.",
    "doc_url": "https://docs.sending.ac/errors/auth-insufficient-scope"
  }
}

404

The requested resource does not exist.

application/json

object

error

required

object

code

required

A machine-readable error code.

string

message

required

A human-readable explanation of the error.

string

doc_url

A link to the documentation page for this error code.

string format: uri

details

For validation errors, a list of individual field-level problems.

Array<object> | null

object

field

required

The field that caused the error, in dot notation.

string

code

A machine-readable code for this specific validation issue.

string

message

required

A human-readable explanation.

string

Example

{
  "error": {
    "code": "resource.not_found",
    "message": "No sender found with ID snd_a1b2c3d4-e5f6-7890-abcd-ef1234567890.",
    "doc_url": "https://docs.sending.ac/errors/resource-not-found"
  }
}

429

You have exceeded the rate limit. Wait and retry.

application/json

object

error

required

object

code

required

A machine-readable error code.

string

message

required

A human-readable explanation of the error.

string

doc_url

A link to the documentation page for this error code.

string format: uri

details

For validation errors, a list of individual field-level problems.

Array<object> | null

object

field

required

The field that caused the error, in dot notation.

string

code

A machine-readable code for this specific validation issue.

string

message

required

A human-readable explanation.

string

Example

{
  "error": {
    "code": "rate.quota_exceeded",
    "message": "Rate limit exceeded. You may make 120 requests per minute. Retry after 30 seconds.",
    "doc_url": "https://docs.sending.ac/errors/rate-quota-exceeded"
  }
}

Headers

Retry-After

integer

Example

Number of seconds to wait before retrying.

X-RateLimit-Limit

integer

Example

The maximum number of requests allowed per minute.

X-RateLimit-Remaining

integer

Example

The number of requests remaining in the current window.

X-RateLimit-Reset

integer

Example

1711267260

Unix timestamp when the rate limit window resets.

Update a sender

Authorizations

Parameters

Path Parameters

Example

Request Bodyrequired

Example

Responses

200

Example

400

Example

401

Examples

403

Example

404

Example

429

Example

Headers

Example

Example

Example

Example

Request Body^required