Skip to main content

Create contact

POST 
/v1/contacts

Create contact

Request​

Header Parameters

    authorization stringrequired

    Possible values: Value must match regular expression /Bearer [^\s]+/

    Default value: Bearer <Token>

    Custom Token generated from the App

Body

    name string

    Full Name of contact

    phone string

    Phone number of the contact

    mobile string

    Mobile number of the contact

    email string

    Email of contact

    jobTitle string

    Job Title of the contact

    list number[]

    ID of Labels the contact has to be added into ?

    contact_type string

    Possible values: [contact, employee]

    Default value: contact

    Type of contact

Responses​

Successful

Schema

    id numberrequired

    ID of the contact

    active booleanrequired

    if true, indicates the contact will actively receive email and sms shares

    unsubscribed booleanrequired

    if true, indicates that the contact is unsubscribed from receiving emails

    fullName string

    Full Name of contact

    mobile string

    Mobile number of the contact

    email string

    Email of contact

    jobTitle string

    Job Title of the contact

    list number[]

    ID of Labels the contact has to be added into. Should we allow id or list name ?

Loading...