Subscribe contact to brands

POST

/v1/contacts/{emailMd5}/subscriptions

const url = 'https://api.optizmo.com/deploy/v1/contacts/93942e96f5acd83e2e047ad8fe03114d/subscriptions';
const options = {
  method: 'POST',
  headers: {Authorization: '<Authorization>', 'Content-Type': 'application/json'},
  body: '{"brandIds":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"]}'
};

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

curl --request POST \
  --url https://api.optizmo.com/deploy/v1/contacts/93942e96f5acd83e2e047ad8fe03114d/subscriptions \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "brandIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ] }'

Subscribes the contact to the given brands and returns the updated subscription list. Only brands the contact is not already subscribed to are added.

Authorizations

optizmo_api_key

Parameters

Path Parameters

emailMd5

required

string

/^[A-Fa-f0-9]{32}$/

The contact identity: the MD5 hex digest of the lowercased email address, md5(lower(email)). Uppercase hex digests are accepted. For example, the contact with email Test@Email.com is addressed by md5('test@email.com') = 93942e96f5acd83e2e047ad8fe03114d.

Request Body^required

application/json

object

brandIds

required

Ids of the brands to subscribe the contact to. Every id must be a brand in your account.

Array<string>

>= 1 items <= 100 items unique items

Example ^generated

{
  "brandIds": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ]
}

Responses

200

The contact’s updated brand subscriptions.

application/json

The brands the contact is subscribed to.

object

brands

required

Array<object>

object

required

The brand id accepted by the subscribe and unsubscribe endpoints.

string format: uuid

name

required

string

Example

{
  "brands": [
    {
      "name": "Acme"
    }
  ]
}

400

One or more brand ids are not brands in your account, or the request body fails validation.

application/json

Error envelope returned by every v1 endpoint for failures, following RFC 9457 Problem Details with code and errors extensions.

object

type

required

URI identifying the problem type; dereferences to its documentation.

string format: uri

status

required

HTTP status code applicable to this problem.

integer

title

required

Short, human-readable summary of the problem type.

string

detail

required

Detailed explanation specific to this occurrence.

string

code

required

Error code identifying the specific error condition.

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error api_error contact_exists operation_in_progress

instance

URI reference identifying this specific occurrence (the request URI).

string format: uri-reference

errors

Provides additional information when the error relates to specific request fields.

Array<object>

object

detail

required

Detailed explanation for this specific field error.

string

pointer

JSON Pointer (RFC 6901) to the request body value that caused the error (e.g. /email, /attributes/firstName).

string

parameter

The URI query parameter that caused the error (e.g. pageSize, name[invalid]).

string

Examples

A brand id is not a brand in your account

{
  "type": "https://docs.optizmo.com/deploy/error-codes#invalid_request_error",
  "status": 400,
  "title": "Invalid request",
  "detail": "Unknown brand id(s): 497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "code": "invalid_request_error",
  "instance": "/deploy/v1/contacts/93942e96f5acd83e2e047ad8fe03114d/subscriptions",
  "errors": [
    {
      "detail": "Unknown brand id(s): 497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "pointer": "/brandIds"
    }
  ]
}

The request body fails validation

{
  "type": "https://docs.optizmo.com/deploy/error-codes#invalid_request_error",
  "status": 400,
  "title": "Invalid request",
  "detail": "each value in brandIds must be a UUID",
  "code": "invalid_request_error",
  "instance": "/deploy/v1/contacts/93942e96f5acd83e2e047ad8fe03114d/subscriptions",
  "errors": [
    {
      "detail": "each value in brandIds must be a UUID"
    }
  ]
}

401

Missing or invalid API key.

application/json

Error envelope returned by every v1 endpoint for failures, following RFC 9457 Problem Details with code and errors extensions.

object

type

required

URI identifying the problem type; dereferences to its documentation.

string format: uri

status

required

HTTP status code applicable to this problem.

integer

title

required

Short, human-readable summary of the problem type.

string

detail

required

Detailed explanation specific to this occurrence.

string

code

required

Error code identifying the specific error condition.

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error api_error contact_exists operation_in_progress

instance

URI reference identifying this specific occurrence (the request URI).

string format: uri-reference

errors

Provides additional information when the error relates to specific request fields.

Array<object>

object

detail

required

Detailed explanation for this specific field error.

string

pointer

JSON Pointer (RFC 6901) to the request body value that caused the error (e.g. /email, /attributes/firstName).

string

parameter

The URI query parameter that caused the error (e.g. pageSize, name[invalid]).

string

Example

{
  "type": "https://docs.optizmo.com/deploy/error-codes#authentication_error",
  "status": 401,
  "title": "Authentication failed",
  "detail": "credentials required",
  "code": "authentication_error",
  "instance": "/deploy/v1/contacts"
}

403

Permission denied.

application/json

Error envelope returned by every v1 endpoint for failures, following RFC 9457 Problem Details with code and errors extensions.

object

type

required

URI identifying the problem type; dereferences to its documentation.

string format: uri

status

required

HTTP status code applicable to this problem.

integer

title

required

Short, human-readable summary of the problem type.

string

detail

required

Detailed explanation specific to this occurrence.

string

code

required

Error code identifying the specific error condition.

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error api_error contact_exists operation_in_progress

instance

URI reference identifying this specific occurrence (the request URI).

string format: uri-reference

errors

Provides additional information when the error relates to specific request fields.

Array<object>

object

detail

required

Detailed explanation for this specific field error.

string

pointer

JSON Pointer (RFC 6901) to the request body value that caused the error (e.g. /email, /attributes/firstName).

string

parameter

The URI query parameter that caused the error (e.g. pageSize, name[invalid]).

string

Example

{
  "type": "https://docs.optizmo.com/deploy/error-codes#permission_error",
  "status": 403,
  "title": "Permission denied",
  "detail": "api key required",
  "code": "permission_error",
  "instance": "/deploy/v1/contacts"
}

404

No contact with this emailMd5 exists in your account.

application/json

Error envelope returned by every v1 endpoint for failures, following RFC 9457 Problem Details with code and errors extensions.

object

type

required

URI identifying the problem type; dereferences to its documentation.

string format: uri

status

required

HTTP status code applicable to this problem.

integer

title

required

Short, human-readable summary of the problem type.

string

detail

required

Detailed explanation specific to this occurrence.

string

code

required

Error code identifying the specific error condition.

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error api_error contact_exists operation_in_progress

instance

URI reference identifying this specific occurrence (the request URI).

string format: uri-reference

errors

Provides additional information when the error relates to specific request fields.

Array<object>

object

detail

required

Detailed explanation for this specific field error.

string

pointer

JSON Pointer (RFC 6901) to the request body value that caused the error (e.g. /email, /attributes/firstName).

string

parameter

The URI query parameter that caused the error (e.g. pageSize, name[invalid]).

string

Example

{
  "type": "https://docs.optizmo.com/deploy/error-codes#not_found_error",
  "status": 404,
  "title": "Not found",
  "detail": "Contact not found",
  "code": "not_found_error",
  "instance": "/deploy/v1/contacts/93942e96f5acd83e2e047ad8fe03114d"
}

409

A bulk contact operation or schema change is in progress for this account (code: operation_in_progress). Retry after the number of seconds given in the Retry-After header.

application/json

Error envelope returned by every v1 endpoint for failures, following RFC 9457 Problem Details with code and errors extensions.

object

type

required

URI identifying the problem type; dereferences to its documentation.

string format: uri

status

required

HTTP status code applicable to this problem.

integer

title

required

Short, human-readable summary of the problem type.

string

detail

required

Detailed explanation specific to this occurrence.

string

code

required

Error code identifying the specific error condition.

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error api_error contact_exists operation_in_progress

instance

URI reference identifying this specific occurrence (the request URI).

string format: uri-reference

errors

Provides additional information when the error relates to specific request fields.

Array<object>

object

detail

required

Detailed explanation for this specific field error.

string

pointer

JSON Pointer (RFC 6901) to the request body value that caused the error (e.g. /email, /attributes/firstName).

string

parameter

The URI query parameter that caused the error (e.g. pageSize, name[invalid]).

string

Example

{
  "type": "https://docs.optizmo.com/deploy/error-codes#operation_in_progress",
  "status": 409,
  "title": "Conflict",
  "detail": "A bulk contact operation or schema change is in progress for this account, retry later",
  "code": "operation_in_progress",
  "instance": "/deploy/v1/contacts/93942e96f5acd83e2e047ad8fe03114d"
}

Headers

Retry-After

integer

Seconds to wait before retrying.

Subscribe contact to brands

Authorizations

Parameters

Path Parameters

Request Body required

Example generated

Responses

200

Example

400

Examples

401

Example

403

Example

404

Example

409

Example

Headers

Request Body^required

Example ^generated