Skip to content

Get recipient

Request

Manage canonical campaign recipients without generation, personalization or sending. external_id maps to the existing campaign employee identity. Mutations require the campaign revision. Claimed, rendered, sent or otherwise active recipients cannot be edited or deleted. Contact details appear only in authorized recipient reads; mutation results contain indexed status metadata.

Security
bearerAuth
Path
idstring^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...required
recipient_idstring^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...required
curl -i -X GET \
  'https://api-docs.shuffll.com/_mock/engage/openapi/v1/campaigns/{id}/recipients/{recipient_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Current resource or page.

Headers
X-Request-Idstring, (uuid)required

Identifier for tracing this response.

ETagstring

Quoted opaque revision when the resource or job result has one.

Bodyapplication/json
idstring^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...required
campaign_idstring^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...required
external_idstringrequired
namestring or nullrequired
Any of:
string
first_namestring or nullrequired
Any of:
string
last_namestring or nullrequired
Any of:
string
phonestring or nullrequired
Any of:
string
lockedbooleanrequired
created_atstringrequired
revisionstring^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...required
Response
{ "id": "string", "campaign_id": "string", "external_id": "string", "name": "string", "first_name": "string", "last_name": "string", "phone": "string", "locked": true, "created_at": "string", "revision": "string" }