Grant offer to contact

Grant offer(s) to a contact

Create an offer grant for a contact which results in creating a new customer record for your contact.

In the request body inlcude offer resource identifier(s), id: OFFER_ID, type: "offers".

To skip sending a welcome email to the customer include a meta object in the request body.

{ "data": [{"type": "offers", "id": "123"}], "meta": {"send_customer_welcome_email": false}}

The meta attribute send_customer_welcome_email as false will prevent sending the welcome email.

(The default behavior is to send the welcome email.)

Response

• A successful response body will list the offers related to the contact
• An error response will include a JSON body with error details.

Behaviors and side effects

• Checks if the contact was already granted the offer
• Checks for existing customerby email
  • If no existing customer, generates a new customer record with contact details
• May send a welcome email to the customer
• May send a gift granted email if this is a gift offer
• Triggers automations if configured

POST /v1/contacts/{contact_id}/relationships/offers

Grant offer to contact

cURL

curl --request POST \
  --url https://api.kajabi.com/v1/contacts/{contact_id}/relationships/offers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": [
    {
      "id": "<string>",
      "type": "<string>"
    }
  ],
  "meta": {
    "send_customer_welcome_email": true
  }
}
'

200

{
  "data": [
    {
      "id": "<string>",
      "type": "<string>"
    }
  ],
  "links": {
    "self": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

contact_id · string · required

Body

application/vnd.api+json

data · object[] · required

Show child attributes

meta · object

Show child attributes

Response

200

application/vnd.api+json

Success, adds tag relationship to contact resource

data · object[]

Show child attributes

links · object

Show child attributes