Grant a lead's consent for a purpose

POST

/api/v1/leads/{id}/consents

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/leads/example/consents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "purpose": "ai_voice_marketing", "source": "web_form", "disclosure_text": "example", "source_record_id": "example", "granted_at": "2026-04-15T12:00:00Z" }'

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Parameters

Path Parameters

id

required

string

Request Body^required

Media typeapplication/json

object

purpose

required

string

Allowed values: ai_voice_marketing sms_marketing email_marketing voice_marketing data_processing

source

required

string

Allowed values: web_form api manual import verbal double_opt_in admin opt_out_reply verbal_logged sales_call system

disclosure_text

required

string

>= 1 characters <= 5000 characters

source_record_id

Any of:

string

string

<= 200 characters

null

null

granted_at

string format: date-time

Responses

201

The recorded consent

Media typeapplication/json

object

consent

required

object

_id

required

string

key

additional properties

any

Example^generated

{
  "consent": {
    "_id": "example"
  }
}

400

Validation failed

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Authentication required or token invalid

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Role permission or token scope missing

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Rate limit exceeded

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}