Skip to main content
Use this endpoint to activate or deactivate a contact. This helps you block payouts to certain contacts, as and when required.

Request

Curl

Response

Success

Parameters

idmandatory : string The unique identifier linked to the contact. For example, cont_00000000000001.

Parameters

activemandatory : boolean Represents the state to which you want to move the contact. A contact can have the following two states:
  • true (default) : active
  • false : inactive
Pass false to deactivate an active contact and pass true to activate a deactivated contact.

Parameters

id : string The unique identifier linked to the contact. For example, cont_00000000000001. entity : string The entity being created. Here, it is contact. name : string The contact’s name. For example, Gaurav Kumar. contact : string The contact’s phone number. For example, 9000090000. email : string The contact’s email address. For example, gaurav.kumar@example.com. type : string A classification for the contact being created. For example, employee. reference_id : string A user-entered reference for the contact. For example, Acme Contact ID 12345. batch_id : string This value is returned if the contact was created as part of a bulk upload. For example, batch_00000000000001. active : boolean Possible values:
  • true (default) : active
  • false : inactive
notes : object Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”. created_at : integer Timestamp, in Unix, when the contact was created. For example, 1545320320.

Errors

“ is not a valid id.
  • code: 4xx
  • description: The contact id entered in the request body is invalid/does not exist.
  • solution: Enter the correct Contact ID. You can find the Contact ID: - In the response body of create a Contact API.