Skip to content

Add a contact

POST
/api/v1/workspaces/{workspace}/contacts
curl --request POST \
--url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/contacts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "consent": "single", "email": "example", "firstName": "example", "language": "example", "lastName": "example", "lists": [ "example" ], "tags": [ "example" ] }'

Permission: subscribers:create

workspace
required

Workspace slug

string
/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

Media typeapplication/json
object
consent
required
string
Allowed values: single double
email
required
string
>= 3 characters <= 254 characters
firstName
string
<= 100 characters
language
string
<= 40 characters
lastName
string
<= 100 characters
lists
required

List ids

Array<string>
<= 50 items
tags
Array<string>
<= 50 items

Created

Media typeapplication/json
object
confirmUrl

Shown when no System provider could send the confirmation

string
confirmationSent
required
boolean
id
required
string

Example generated

{
"confirmUrl": "example",
"confirmationSent": true,
"id": "example"
}

Error

Media typeapplication/problem+json
object
code

Stable error code, e.g. permission_denied

string
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object>
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

helpers

Members who hold the missing permission

Array<string>
instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
meta
object
key
additional properties
permission

The missing permission key

string
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank

Example

{
"detail": "Property foo is required but is missing.",
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "about:blank"
}